All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class symantec.itools.awt.ButtonBase

Object
   |
   +----Component
           |
           +----Canvas
                   |
                   +----symantec.itools.awt.ButtonBase

public abstract class ButtonBase

extends Canvas

Version:

1.1, June 26, 1997

Author:

Symantec

bevel

The "height" (cross-section) of a beveled edge, in pixels.

borderColor

The color of the border around the button.

buttonColor

The color of the content of the button.

buttonImage

The offscreen buffer to draw the button in.

buttonImageGraphics

The Graphics of the offscreen buffer to draw the button in.

context

Applet context that shows the document.

errors

Error strings.

frame

Frame specifier for showing a URL document in a browser or applet viewer.

inButton

True if the mouse is over this button.

isAdded

Keeps track of wheather or not the button is added to a container.

linkURL

The URL of the document to show when the button is clicked.

notified

True if a notification has been posted in response to a mouse down.

notifyDelay

The delay in milliseconds between notifications while the button is pressed.

notifyTimer

Timer used to time notification events while button pressed.

notifyWhilePressed

If true the button will continuously post events while pressed.

pressed

True if the button is currently pressed.

pressedAdjustment

A drawing location adjustment for the 3-D bevel while button is pressed.

released

True if the button has been released.

running

True if the notify timer is running.

showFocus

If true this component will visually indicate when it has the focus.

showURLStatus

If true show the linkURL in the status area when the mouse is over the button.

tempBevelHeight

Internal use.

useOffset

If true set pressedAdjustment accordingly, else, it is always 0.

symantec.itools.awt.ButtonBase()

Constructs a default ButtonBase.

addActionListener(ActionListener)

Adds the specified action listener to receive action events from this button.

addBevelHeightListener(PropertyChangeListener)

Adds a listener for the BevelHeight property changes.

addBevelHeightListener(VetoableChangeListener)

Adds a vetoable listener for the BevelHeight property changes.

addFrameListener(PropertyChangeListener)

Adds a listener for the Frame property changes.

addFrameListener(VetoableChangeListener)

Adds a vetoable listener for the Frame property changes.

addNotify()

Tells this component that it has been added to a container.

addPropertyChangeListener(PropertyChangeListener)

Adds a listener for all event changes.

addVetoableChangeListener(VetoableChangeListener)

Adds a vetoable listener for all event changes.

disable()

enable()

getActionCommand()

Returns the command name of the action event fired by this button.

getBevelHeight()

Returns the current "height" (cross-section) of a beveled edge, in pixels.

getBorderColor()

Gets the current border color.

getButtonColor()

Gets the current button color.

getFrame()

Gets the frame specifier for showing a URL document in a browser or applet viewer.

getLinkURL()

Returns the URL of the document to link to when the button is clicked.

getMinimumSize()

Returns the minimum dimensions to properly display this component.

getNotifyDelay()

Returns the current delay in milliseconds between notification events.

getNotifyWhilePressed()

getPreferredSize()

Returns the recommended dimensions to properly display this component.

getShowFocus()

isButtonImageInvalid()

Returns true if a button image has been set, but it is not the size of this component.

isFocusTraversable()

isNotifyWhilePressed()

Gets whether the button will continuously post events while pressed.

isShowFocus()

Gets whether this component will visually indicate when it has the focus.

isShowURLStatus()

If true show the linkURL in the status area when the mouse is over the button.

isUseOffset()

Gets whether objects in the button will be offset down and to the right by the bevel height amount or not.

isValidBevelSize(int)

Is the given bevel size valid for this button.

isValidFrame(String)

Is the given frame string valid.

linkToURL()

Tell the browser to show the document referenced by the linkURL.

minimumSize()

paint(Graphics)

Paints this component using the given graphics context.

preferredSize()

removeActionListener(ActionListener)

Removes the specified action listener so it no longer receives action events from this button.

removeBevelHeightListener(PropertyChangeListener)

Removes a listener for the BevelHeight property changes.

removeBevelHeightListener(VetoableChangeListener)

Removes a vetoable listener for the BevelHeight property changes.

removeFrameListener(PropertyChangeListener)

Removes a listener for the Frame property changes.

removeFrameListener(VetoableChangeListener)

Removes a vetoable listener for the Frame property changes.

removeNotify()

Tells this component that it is being removed from a container.

removePropertyChangeListener(PropertyChangeListener)

Removes a listener for all event changes.

removeVetoableChangeListener(VetoableChangeListener)

Removes a vetoable listener for all event changes.

setActionCommand(String)

Sets the command name of the action event fired by this button.

setAppletContext(AppletContext)

Sets the applet context used to view documents.

setBevelHeight(int)

Sets the "height" (cross-section) of a beveled edge, in pixels.

setBorderColor(Color)

Sets the current border color.

setButtonColor(Color)

Sets the current button color.

setEnabled(boolean)

Enables this component so that it will respond to user input.

setFrame(String)

Sets the frame specifier for showing a URL document in a browser or applet viewer.

setLinkURL(URL)

Sets the URL of the document to link to when the button is clicked.

setNotifyDelay(int)

Sets the notification event delay in milliseconds.

setNotifyWhilePressed(boolean)

Sets whether the button will continually post notify events while pressed.

setShowFocus(boolean)

Sets whether this component will visually indicate when it has the focus.

setShowURLStatus(boolean)

Sets whether the linkURL will be displayed in the status area when the mouse is over the button.

setUseOffset(boolean)

Sets whether objects in the button will be offset down and to the right by the bevel height amount or not.

simulateClick()

Makes the button act as if it was pressed, drawing as if it were clicked and sending an action event as if it were clicked.

sourceActionEvent()

Fire an action event to the listeners.

update(Graphics)

Handles redrawing of this component on the screen.

updateButtonImage()

Maintains the buttonImage size and draws the button in the buttonImage offscreen image.

validate()

Ensures that this component is laid out properly, as needed.

verifyContstrainedPropertyValues()

Called after addNotify to set the internally constrined properties to their temporary values to validate them now that the component has been added to the form.

protected int bevel

The "height" (cross-section) of a beveled edge, in pixels.

protected java.awt.Color borderColor

The color of the border around the button.

protected java.awt.Color buttonColor

The color of the content of the button. The highlights are derived from this color.

protected transient java.awt.Image buttonImage

The offscreen buffer to draw the button in.

protected transient java.awt.Graphics buttonImageGraphics

The Graphics of the offscreen buffer to draw the button in.

protected transient java.applet.AppletContext context

Applet context that shows the document.

protected transient java.util.ResourceBundle errors

Error strings.

protected java.lang.String frame

Frame specifier for showing a URL document in a browser or applet viewer. It is interpreted as follows:

"_self" show document in the current frame
"_parent" show document in the parent frame
"_top" show document in the topmost frame
"_blank" show document in a new unnamed toplevel window
all others show document in a new toplevel window with the given name

protected transient boolean inButton

True if the mouse is over this button.

protected transient boolean isAdded

Keeps track of wheather or not the button is added to a container. Check before attempting to getFontMetrics() to avoid getting a null pointer.

protected java.net.URL linkURL

The URL of the document to show when the button is clicked.

protected transient boolean notified

True if a notification has been posted in response to a mouse down.

protected int notifyDelay

The delay in milliseconds between notifications while the button is pressed.

protected symantec.itools.util.Timer notifyTimer

Timer used to time notification events while button pressed.

protected boolean notifyWhilePressed

If true the button will continuously post events while pressed.

protected transient boolean pressed

True if the button is currently pressed.

protected int pressedAdjustment

A drawing location adjustment for the 3-D bevel while button is pressed.

protected transient boolean released

True if the button has been released.

protected transient boolean running

True if the notify timer is running.

protected boolean showFocus

If true this component will visually indicate when it has the focus. This is done by drawing a focus rectangle within the component as needed.

protected boolean showURLStatus

If true show the linkURL in the status area when the mouse is over the button. If the linkURL is null, nothing is displayed, regardless of this flag. This flag also controls erasing of the status area after the URL has been displayed.

protected int tempBevelHeight

Internal use. Bevel height value stored until this component is added to a container. It is then used to set the real bevel height value. This avoids code-gen order dependencies.

protected boolean useOffset

If true set pressedAdjustment accordingly, else, it is always 0.

protected ButtonBase()

Constructs a default ButtonBase. The defaults are no notifyWhilePressed, no offset, and a bevel height of 2.

public synchronized void addActionListener(ActionListener l)

Adds the specified action listener to receive action events from this button.

Parameters:

l - the action listener

public synchronized void addBevelHeightListener(PropertyChangeListener listener)

Adds a listener for the BevelHeight property changes.

Parameters:

listener - the listener to add.

See Also:

removeBevelHeightListener(java.beans.PropertyChangeListener)

public synchronized void addBevelHeightListener(VetoableChangeListener listener)

Adds a vetoable listener for the BevelHeight property changes.

Parameters:

listener - the listener to add.

See Also:

removeBevelHeightListener(java.beans.VetoableChangeListener)

public synchronized void addFrameListener(PropertyChangeListener listener)

Adds a listener for the Frame property changes.

Parameters:

listener - the listener to add.

See Also:

removeFrameListener(java.beans.PropertyChangeListener)

public synchronized void addFrameListener(VetoableChangeListener listener)

Adds a vetoable listener for the Frame property changes.

Parameters:

listener - the listener to add.

See Also:

removeFrameListener(java.beans.VetoableChangeListener)

public synchronized void addNotify()

Tells this component that it has been added to a container. This is a standard Java AWT method which gets called by the AWT when this component is added to a container. Typically, it is used to create this component's peer. It has been overridden here to hook-up event listeners.

Overrides:

addNotify in class Canvas

See Also:

removeNotify

public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

Adds a listener for all event changes.

Parameters:

listener - the listener to add.

See Also:

removePropertyChangeListener

public synchronized void addVetoableChangeListener(VetoableChangeListener listener)

Adds a vetoable listener for all event changes.

Parameters:

listener - the listener to add.

See Also:

removeVetoableChangeListener

public void disable()

Note: disable() is deprecated.

Overrides:

disable in class Component

See Also:

setEnabled

public void enable()

Note: enable() is deprecated.

Overrides:

enable in class Component

See Also:

setEnabled

public java.lang.String getActionCommand()

Returns the command name of the action event fired by this button.

Returns:

the action command name

public int getBevelHeight()

Returns the current "height" (cross-section) of a beveled edge, in pixels.

Returns:

the current bevel height in pixels.

See Also:

setBevelHeight

public java.awt.Color getBorderColor()

Gets the current border color.

Returns:

the current border color

See Also:

setBorderColor

public java.awt.Color getButtonColor()

Gets the current button color.

Returns:

the current button color

See Also:

setButtonColor

public java.lang.String getFrame()

Gets the frame specifier for showing a URL document in a browser or applet viewer. It is interpreted as follows:

"_self" show document in the current frame
"_parent" show document in the parent frame
"_top" show document in the topmost frame
"_blank" show document in a new unnamed toplevel window
all others show document in a new toplevel window with the given name

Returns:

the frame specifier

See Also:

setFrame, frameTarget_self, frameTarget_parent, frameTarget_top, frameTarget_blank

public java.net.URL getLinkURL()

Returns the URL of the document to link to when the button is clicked.

See Also:

setLinkURL

public java.awt.Dimension getMinimumSize()

Returns the minimum dimensions to properly display this component. This is a standard Java AWT method which gets called to determine the minimum size of this component. It simply returns the results of a call to preferedSize().

Overrides:

getMinimumSize in class Component

public int getNotifyDelay()

Returns the current delay in milliseconds between notification events.

See Also:

setNotifyWhilePressed, setNotifyDelay

public boolean getNotifyWhilePressed()

Note: getNotifyWhilePressed() is deprecated.

See Also:

isNotifyWhilePressed

public java.awt.Dimension getPreferredSize()

Returns the recommended dimensions to properly display this component. This is a standard Java AWT method which gets called to determine the recommended size of this component.

Overrides:

getPreferredSize in class Component

public boolean getShowFocus()

Note: getShowFocus() is deprecated.

See Also:

isShowFocus

protected boolean isButtonImageInvalid()

Returns true if a button image has been set, but it is not the size of this component.

public boolean isFocusTraversable()

Overrides:

isFocusTraversable in class Component

public boolean isNotifyWhilePressed()

Gets whether the button will continuously post events while pressed.

Returns:

true if it will continuously post events while pressed, false otherwise

See Also:

setNotifyWhilePressed, setNotifyDelay, getNotifyDelay

public boolean isShowFocus()

Gets whether this component will visually indicate when it has the focus. This is done by drawing a focus rectangle within the component as needed.

Returns:

true if the focus is visually indicated, false if the focus is never indicated

See Also:

setShowFocus

public boolean isShowURLStatus()

If true show the linkURL in the status area when the mouse is over the button. If the linkURL is null, nothing is displayed, regardless of this flag. This flag also controls erasing of the status area after the URL has been displayed.

Returns:

true if the linkURL will be displayed in the status area when the mouse is over the button.

See Also:

setShowURLStatus

public boolean isUseOffset()

Gets whether objects in the button will be offset down and to the right by the bevel height amount or not. This also impacts the way the button is drawn when it is pressed.

Returns:

true if bevel offset is used

See Also:

setUseOffset

protected boolean isValidBevelSize(int i)

Is the given bevel size valid for this button.

Parameters:

i - the given bevel size

Returns:

true if the given bevel size is acceptable, false if not.

protected boolean isValidFrame(String string)

Is the given frame string valid.

Parameters:

string - the given frame

Returns:

true if the given frame is acceptable, false if not. To be valid it has to be null, or one of the four strings below:

See Also:

frameTarget_self, frameTarget_parent, frameTarget_top, frameTarget_blank

protected void linkToURL()

Tell the browser to show the document referenced by the linkURL. If the frame specifier is not null or empty, then tell the browser to open the document with that frame.

public java.awt.Dimension minimumSize()

Note: minimumSize() is deprecated.

Overrides:

minimumSize in class Component

See Also:

getMinimumSize

public void paint(Graphics g)

Paints this component using the given graphics context. This is a standard Java AWT method which typically gets called by the AWT to handle painting this component. It paints this component using the given graphics context. The graphics context clipping region is set to the bounding rectangle of this component and its [0,0] coordinate is this component's top-left corner.

Parameters:

g - the graphics context used for painting

Overrides:

paint in class Canvas

See Also:

repaint, update

public java.awt.Dimension preferredSize()

Note: preferredSize() is deprecated.

Overrides:

preferredSize in class Component

See Also:

getPreferredSize

public synchronized void removeActionListener(ActionListener l)

Removes the specified action listener so it no longer receives action events from this button.

Parameters:

l - the action listener

public synchronized void removeBevelHeightListener(PropertyChangeListener listener)

Removes a listener for the BevelHeight property changes.

Parameters:

listener - the listener to remove.

See Also:

addBevelHeightListener(java.beans.PropertyChangeListener)

public synchronized void removeBevelHeightListener(VetoableChangeListener listener)

Removes a vetoable listener for the BevelHeight property changes.

Parameters:

listener - the listener to remove.

See Also:

addBevelHeightListener(java.beans.VetoableChangeListener)

public synchronized void removeFrameListener(PropertyChangeListener listener)

Removes a listener for the Frame property changes.

Parameters:

listener - the listener to remove.

See Also:

addFrameListener(java.beans.PropertyChangeListener)

public synchronized void removeFrameListener(VetoableChangeListener listener)

Removes a vetoable listener for the Frame property changes.

Parameters:

listener - the listener to remove.

See Also:

addFrameListener(java.beans.VetoableChangeListener)

public synchronized void removeNotify()

Tells this component that it is being removed from a container. This is a standard Java AWT method which gets called by the AWT when this component is removed from a container. Typically, it is used to destroy the peers of this component and all its subcomponents. It has been overridden here to unhook event listeners.

Overrides:

removeNotify in class Component

See Also:

addNotify

public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

Removes a listener for all event changes.

Parameters:

listener - the listener to remove.

See Also:

addPropertyChangeListener

public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)

Removes a vetoable listener for all event changes.

Parameters:

listener - the listener to remove.

See Also:

addVetoableChangeListener

public void setActionCommand(String command) throws PropertyVetoException

Sets the command name of the action event fired by this button.

Parameters:

command - The name of the action event command fired by this button

Throws: PropertyVetoException

if the specified property value is unacceptable

protected void setAppletContext(AppletContext c)

Sets the applet context used to view documents.

Parameters:

c - the new applet context

public void setBevelHeight(int height) throws PropertyVetoException

Sets the "height" (cross-section) of a beveled edge, in pixels.

Parameters:

height - the size of the bevel in pixels

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getBevelHeight

public void setBorderColor(Color color) throws PropertyVetoException

Sets the current border color.

Parameters:

color - the new border color

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getBorderColor

public void setButtonColor(Color color) throws PropertyVetoException

Sets the current button color.

Parameters:

color - the new button color. The highlights of the button are derived from this color.

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getButtonColor

public void setEnabled(boolean flag)

Enables this component so that it will respond to user input. This is a standard Java AWT method which gets called to enable or disable this component. Once enabled this component will respond to user input.

Parameters:

flag - true if the component is to be enabled; false if it is to be disabled.

Overrides:

setEnabled in class Component

See Also:

isEnabled

public void setFrame(String newFrame) throws PropertyVetoException

Sets the frame specifier for showing a URL document in a browser or applet viewer. It is interpreted as follows:

"_self" show document in the current frame
"_parent" show document in the parent frame
"_top" show document in the topmost frame
"_blank" show document in a new unnamed toplevel window
all others show document in a new toplevel window with the given name

Parameters:

newFrame - the frame specifier

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getFrame, frameTarget_self, frameTarget_parent, frameTarget_top, frameTarget_blank

public void setLinkURL(URL url) throws PropertyVetoException

Sets the URL of the document to link to when the button is clicked.

Parameters:

url - the URL

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getLinkURL

public void setNotifyDelay(int delay) throws PropertyVetoException

Sets the notification event delay in milliseconds.

Parameters:

delay - the delay between notification events in milliseconds

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

setNotifyWhilePressed, getNotifyDelay

public void setNotifyWhilePressed(boolean flag) throws PropertyVetoException

Sets whether the button will continually post notify events while pressed.

Parameters:

flag - true to post notify events; false to not post events

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

isNotifyWhilePressed, setNotifyDelay, getNotifyDelay

public void setShowFocus(boolean flag) throws PropertyVetoException

Sets whether this component will visually indicate when it has the focus. This is done by drawing a focus rectangle within the component as needed.

Parameters:

flag - true to visually indicate focus, false to never indicate focus

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

isShowFocus

public void setShowURLStatus(boolean flag) throws PropertyVetoException

Sets whether the linkURL will be displayed in the status area when the mouse is over the button. This flag also controls erasing of the status area after the URL has been displayed.

Parameters:

flag - true if the linkURL will be displayed in the status area when the mouse is over the button; false if not.

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

isShowURLStatus

public void setUseOffset(boolean flag) throws PropertyVetoException

Sets whether objects in the button will be offset down and to the right by the bevel height amount or not. This also impacts the way the button is drawn when it is pressed.

Parameters:

flag - true to have objects use the offset; false to have objects not move.

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

isUseOffset, setBevelHeight, getBevelHeight

public void simulateClick()

Makes the button act as if it was pressed, drawing as if it were clicked and sending an action event as if it were clicked.

protected void sourceActionEvent()

Fire an action event to the listeners.

public void update(Graphics g)

Handles redrawing of this component on the screen. This is a standard Java AWT method which gets called by the Java AWT (repaint()) to handle repainting this component on the screen. The graphics context clipping region is set to the bounding rectangle of this component and its [0,0] coordinate is this component's top-left corner. Typically this method paints the background color to clear the component's drawing space, sets graphics context to be the foreground color, and then calls paint() to draw the component. It is overridden here to prevent the flicker associated with the standard update() method's repainting of the background before painting the component itself.

Parameters:

g - the graphics context

Overrides:

update in class Component

See Also:

repaint, paint

protected void updateButtonImage()

Maintains the buttonImage size and draws the button in the buttonImage offscreen image.

See Also:

paint

public void validate()

Ensures that this component is laid out properly, as needed. This is a standard Java AWT method which gets called by the AWT to make sure this component and its subcomponents have a valid layout. If this component was made invalid with a call to invalidate(), then it is laid out again. It is overridden here to locate the applet containing this component.

Overrides:

validate in class Component

See Also:

invalidate

protected void verifyContstrainedPropertyValues()

Called after addNotify to set the internally constrined properties to their temporary values to validate them now that the component has been added to the form. This is used to avoid code-gen order dependencies, since VC generates all property manipulating code before adding the component to its container. Subclasses should override this function for any internally constrained properties, and call the super version in the overridden version.

All Packages  Class Hierarchy  This Package  Previous  Next  Index